<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="workloadmanager_v1.html">Workload Manager API</a> . <a href="workloadmanager_v1.projects.html">projects</a> . <a href="workloadmanager_v1.projects.locations.html">locations</a> . <a href="workloadmanager_v1.projects.locations.workloadProfiles.html">workloadProfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single workload.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List workloads</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of a single workload.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # workload resource
  &quot;application&quot;: { # The database layer # Optional. The application layer
    &quot;applicationType&quot;: &quot;A String&quot;, # the application layer
    &quot;databaseType&quot;: &quot;A String&quot;, # Optional. the database layer
    &quot;instances&quot;: [ # Optional. instances in a layer
      { # a vm instance
        &quot;name&quot;: &quot;A String&quot;, # Output only. name of the VM
        &quot;region&quot;: &quot;A String&quot;, # Output only. The location of the VM
        &quot;status&quot;: &quot;A String&quot;, # Output only. The state of the VM
      },
    ],
    &quot;sid&quot;: &quot;A String&quot;, # Output only. system identification of a layer
  },
  &quot;ascs&quot;: { # The database layer # Optional. The ascs layer
    &quot;applicationType&quot;: &quot;A String&quot;, # the application layer
    &quot;databaseType&quot;: &quot;A String&quot;, # Optional. the database layer
    &quot;instances&quot;: [ # Optional. instances in a layer
      { # a vm instance
        &quot;name&quot;: &quot;A String&quot;, # Output only. name of the VM
        &quot;region&quot;: &quot;A String&quot;, # Output only. The location of the VM
        &quot;status&quot;: &quot;A String&quot;, # Output only. The state of the VM
      },
    ],
    &quot;sid&quot;: &quot;A String&quot;, # Output only. system identification of a layer
  },
  &quot;database&quot;: { # The database layer # Optional. The database layer
    &quot;applicationType&quot;: &quot;A String&quot;, # the application layer
    &quot;databaseType&quot;: &quot;A String&quot;, # Optional. the database layer
    &quot;instances&quot;: [ # Optional. instances in a layer
      { # a vm instance
        &quot;name&quot;: &quot;A String&quot;, # Output only. name of the VM
        &quot;region&quot;: &quot;A String&quot;, # Output only. The location of the VM
        &quot;status&quot;: &quot;A String&quot;, # Output only. The state of the VM
      },
    ],
    &quot;sid&quot;: &quot;A String&quot;, # Output only. system identification of a layer
  },
  &quot;labels&quot;: { # Optional. such as name, description, version. More example can be found in deployment
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. name of resource names have the form &#x27;projects/{project_id}/workloads/{workload_id}&#x27;
  &quot;refreshedTime&quot;: &quot;A String&quot;, # Required. time when the workload data was refreshed
  &quot;sapWorkload&quot;: { # The body of sap workload # The sap workload content
    &quot;application&quot;: { # The component of sap workload # Output only. the acsc componment
      &quot;haHosts&quot;: [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
        &quot;A String&quot;,
      ],
      &quot;resources&quot;: [ # Output only. resources in the component
        { # The resource on GCP
          &quot;kind&quot;: &quot;A String&quot;, # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          &quot;name&quot;: &quot;A String&quot;, # Output only. resource name
        },
      ],
      &quot;sid&quot;: &quot;A String&quot;, # Output only. sid is the sap component identificator
      &quot;topologyType&quot;: &quot;A String&quot;, # The detected topology of the component.
    },
    &quot;database&quot;: { # The component of sap workload # Output only. the database componment
      &quot;haHosts&quot;: [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
        &quot;A String&quot;,
      ],
      &quot;resources&quot;: [ # Output only. resources in the component
        { # The resource on GCP
          &quot;kind&quot;: &quot;A String&quot;, # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          &quot;name&quot;: &quot;A String&quot;, # Output only. resource name
        },
      ],
      &quot;sid&quot;: &quot;A String&quot;, # Output only. sid is the sap component identificator
      &quot;topologyType&quot;: &quot;A String&quot;, # The detected topology of the component.
    },
    &quot;metadata&quot;: { # Output only. The metadata for SAP workload.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
  },
  &quot;sqlserverWorkload&quot;: { # The body of sqlserver workload # The sqlserver workload content
    &quot;ags&quot;: [ # Output only. The availability groups for sqlserver
      { # The availability groups for sqlserver
        &quot;databases&quot;: [ # Output only. The databases
          &quot;A String&quot;,
        ],
        &quot;name&quot;: &quot;A String&quot;, # Output only. The availability group name
        &quot;primaryServer&quot;: &quot;A String&quot;, # Output only. The primary server
        &quot;secondaryServers&quot;: [ # Output only. The secondary servers
          &quot;A String&quot;,
        ],
      },
    ],
    &quot;cluster&quot;: { # The cluster for sqlserver # Output only. The cluster for sqlserver
      &quot;nodes&quot;: [ # Output only. The nodes
        &quot;A String&quot;,
      ],
      &quot;witnessServer&quot;: &quot;A String&quot;, # Output only. The witness server
    },
    &quot;databases&quot;: [ # Output only. The databases for sqlserver
      { # The database for sqlserver
        &quot;backupFile&quot;: &quot;A String&quot;, # Output only. The backup file
        &quot;backupSchedule&quot;: &quot;A String&quot;, # Output only. The backup schedule
        &quot;hostVm&quot;: &quot;A String&quot;, # Output only. The host VM
        &quot;name&quot;: &quot;A String&quot;, # Output only. The database name
      },
    ],
    &quot;loadBalancerServer&quot;: { # The load balancer for sqlserver # Output only. The load balancer for sqlserver
      &quot;ip&quot;: &quot;A String&quot;, # Output only. The IP address
      &quot;vm&quot;: &quot;A String&quot;, # Output only. The VM name
    },
  },
  &quot;state&quot;: &quot;A String&quot;, # Output only. [output only] the current state if a a workload
  &quot;threeTierWorkload&quot;: { # The body of three tier workload # The 3 tier web app workload content
    &quot;apiLayer&quot;: { # The API layer server # Output only. The API layer for three tier workload
      &quot;name&quot;: &quot;A String&quot;, # Output only. The api layer name
      &quot;osVersion&quot;: &quot;A String&quot;, # Output only. OS information
      &quot;resources&quot;: [ # Output only. resources in the component
        { # The resource on GCP
          &quot;kind&quot;: &quot;A String&quot;, # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          &quot;name&quot;: &quot;A String&quot;, # Output only. resource name
        },
      ],
    },
    &quot;backend&quot;: { # The backend server # Output only. The backend for three tier workload
      &quot;backupFile&quot;: &quot;A String&quot;, # Output only. The backup file
      &quot;backupSchedule&quot;: &quot;A String&quot;, # Output only. The backup schedule
      &quot;name&quot;: &quot;A String&quot;, # Output only. The backend name
      &quot;osVersion&quot;: &quot;A String&quot;, # Output only. OS information
      &quot;resources&quot;: [ # Output only. resources in the component
        { # The resource on GCP
          &quot;kind&quot;: &quot;A String&quot;, # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          &quot;name&quot;: &quot;A String&quot;, # Output only. resource name
        },
      ],
    },
    &quot;endpoint&quot;: &quot;A String&quot;, # Output only. the workload endpoint
    &quot;frontend&quot;: { # The front end server # Output only. The frontend for three tier workload
      &quot;name&quot;: &quot;A String&quot;, # Output only. The frontend name
      &quot;osVersion&quot;: &quot;A String&quot;, # Output only. OS information
      &quot;resources&quot;: [ # Output only. resources in the component
        { # The resource on GCP
          &quot;kind&quot;: &quot;A String&quot;, # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          &quot;name&quot;: &quot;A String&quot;, # Output only. resource name
        },
      ],
    },
  },
  &quot;workloadType&quot;: &quot;A String&quot;, # Required. The type of the workload
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List workloads

Args:
  parent: string, Required. Parent value for ListWorkloadRequest (required)
  filter: string, Optional. Filtering results
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List workloadResponse returns a response with the list of workload overview
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. A token identifying a page of results the server should return
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
  &quot;workloadOverviews&quot;: [ # Output only. The list of Workload Overview
    { # a workload profile overview
      &quot;sapWorkloadOverview&quot;: { # The overview of sap workload # The sap workload overview
        &quot;appSid&quot;: &quot;A String&quot;, # Output only. The application SID
        &quot;dbSid&quot;: &quot;A String&quot;, # Output only. The database SID
        &quot;sapSystemId&quot;: &quot;A String&quot;, # Output only. The UUID for a SAP workload
      },
      &quot;sqlserverWorkloadOverview&quot;: { # The overview of sqlserver workload # The sqlserver workload overview
        &quot;availabilityGroup&quot;: [ # Output only. The availability groups
          &quot;A String&quot;,
        ],
        &quot;sqlserverSystemId&quot;: &quot;A String&quot;, # Output only. The UUID for a Sqlserver workload
      },
      &quot;threeTierWorkloadOverview&quot;: { # The overview of three tier workload # The three tier workload overview
        &quot;threeTierSystemId&quot;: &quot;A String&quot;, # Output only. The UUID for a three tier workload
      },
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>